home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilPolyadicImg.z / ilPolyadicImg
Encoding:
Text File  |  2002-10-03  |  15.0 KB  |  331 lines
  1.  
  2.  
  3.  
  4. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg - base class for N-input operators
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink : ilImage : ilCacheImg : ilMemCacheImg : ilOpImg
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilPolyadicImg.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilPolyadicImg is the base class for IL operator images with multiple
  19.      input (parent) images. This class is only useable when derived from to
  20.      define the processing to be perform using the virtual, ccccaaaallllccccPPPPaaaaggggeeee(); there
  21.      is no public constructor.
  22.  
  23. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  24.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  25.  
  26.           ilPolyadicImg(int numInputs = -1)    _p_r_o_t_e_c_t_e_d
  27.  
  28.      GGGGeeeetttt////sssseeeetttt mmmmeeeetttthhhhooooddddssss
  29.  
  30.           void setOffset(int x, int y, int z = 0, int idx = 0)
  31.           ilStatus getOffset(int &x, int &y, int &z, int idx = 0)
  32.           iflXYZint* getOffsets()
  33.           int getNumActiveInputs()
  34.           ilImage* getActiveInput(int idx=0)
  35.           ilStatus getActiveOffset(int &x, int &y, int &z, int idx = 0)
  36.           double getActiveInputMin(int idx=0)
  37.           double getActiveInputMax(int idx=0)
  38.  
  39.      DDDDeeeeffffiiiinnnniiiinnnngggg tttthhhheeee iiiimmmmaaaaggggeeee pppprrrroooocccceeeessssssssiiiinnnngggg ooooppppeeeerrrraaaattttiiiioooonnnn
  40.  
  41.           virtual ilStatus calcPage(void** inBuf, int numIn, void* outBuf,
  42.                                     ilMpCacheRequest& req)    _p_r_o_t_e_c_t_e_d
  43.  
  44.  
  45. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  46.      iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg(((())))
  47.  
  48.           ilPolyadicImg(int numInputs = -1)    _p_r_o_t_e_c_t_e_d
  49.  
  50.  
  51.           The constructor take a single argument, _n_u_m_I_n_p_u_t_s, that specifies
  52.           the maximum number of inputs that a derived class will accept.  The
  53.           default value, -1, indicates that an unlimited number of inputs are
  54.           allowed.
  55.  
  56.      ccccaaaallllccccPPPPaaaaggggeeee(((())))
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  71.  
  72.  
  73.  
  74.           virtual ilStatus calcPage(void** inBuf, int numIn, void* outBuf,
  75.                                     ilMpCacheRequest& req)    _p_r_o_t_e_c_t_e_d
  76.  
  77.  
  78.           This method must be defined to by a derived class to implement the
  79.           actual image processing algorithm.  The input buffers are passed in
  80.           an array of void pointers, _i_n_B_u_f, of length, _n_u_m_I_n.  The output data
  81.           is placed in _o_u_t_B_u_f. The page origin and size are defined by the
  82.           (_x,_y,_z,_c) and (_n_x,_n_y,_n_z,_n_c) members of _r_e_q.
  83.  
  84.      ggggeeeettttAAAAccccttttiiiivvvveeeeIIIInnnnppppuuuutttt(((())))
  85.  
  86.           ilImage* getActiveInput(int idx=0)
  87.  
  88.  
  89.           This method returns the _i_d_x'th active input (zero relative).  An
  90.           active input is any input that is non-NULL.
  91.  
  92.      ggggeeeettttAAAAccccttttiiiivvvveeeeIIIInnnnppppuuuuttttMMMMaaaaxxxx(((())))
  93.  
  94.           double getActiveInputMax(int idx=0)
  95.  
  96.  
  97.           This method returns the maximum pixel value of the _i_d_x'th active
  98.           input (zero relative).  An active input is any input that is non-
  99.           NULL.
  100.  
  101.      ggggeeeettttAAAAccccttttiiiivvvveeeeIIIInnnnppppuuuuttttMMMMiiiinnnn(((())))
  102.  
  103.           double getActiveInputMin(int idx=0)
  104.  
  105.  
  106.           This method returns the minimum pixel value of the _i_d_x'th active
  107.           input (zero relative).  An active input is any input that is non-
  108.           NULL.
  109.  
  110.      ggggeeeettttAAAAccccttttiiiivvvveeeeOOOOffffffffsssseeeetttt(((())))
  111.  
  112.           ilStatus getActiveOffset(int &x, int &y, int &z, int idx = 0)
  113.  
  114.  
  115.           This method returns the (_x,_y,_z) offsets of the _i_d_x'th active input
  116.           (zero relative). An active input is any input that is non-NULL.
  117.           Those offsets are subtracted from the page origin in
  118.           pppprrrreeeeppppaaaarrrreeeeRRRReeeeqqqquuuueeeesssstttt() to determine the tile to be accessed from the
  119.           indicated input.
  120.  
  121.      ggggeeeettttNNNNuuuummmmAAAAccccttttiiiivvvveeeeIIIInnnnppppuuuuttttssss(((())))
  122.  
  123.           int getNumActiveInputs()
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  137.  
  138.  
  139.  
  140.           This method returns the number of active (non-NULL) inputs.
  141.  
  142.      ggggeeeettttOOOOffffffffsssseeeetttt(((())))
  143.  
  144.           ilStatus getOffset(int &x, int &y, int &z, int idx = 0)
  145.  
  146.  
  147.           This method returns the (_x,_y,_z) offsets of the _i_d_x'th input (zero
  148.           relative). Those offsets are subtracted from the page origin in
  149.           pppprrrreeeeppppaaaarrrreeeeRRRReeeeqqqquuuueeeesssstttt() to determine the tile to be accessed from the
  150.           indicated input.
  151.  
  152.      ggggeeeettttOOOOffffffffsssseeeettttssss(((())))
  153.  
  154.           iflXYZint* getOffsets()
  155.  
  156.  
  157.           This method returns an array of offsets (as iflXYZint's) for all of
  158.           the inputs.  Set ggggeeeettttOOOOffffffffsssseeeetttt() for more details on the offset
  159.           interpretation.
  160.  
  161.      sssseeeettttOOOOffffffffsssseeeetttt(((())))
  162.  
  163.           void setOffset(int x, int y, int z = 0, int idx = 0)
  164.  
  165.  
  166.           This method sets the (_x,_y,_z) offsets of the _i_d_x'th input (zero
  167.           relative). Those offsets are subtracted from the page origin in
  168.           pppprrrreeeeppppaaaarrrreeeeRRRReeeeqqqquuuueeeesssstttt() to determine the tile to be accessed from the
  169.           indicated input.
  170.  
  171. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  172.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllOOOOppppIIIImmmmgggg
  173.      checkMinMax(), clearClamp(), getBias(), getClamp(), getInputMax(),
  174.      getInputMin(), getInputScaleMax(), getInputScaleMin(), getValidOrders(),
  175.      getValidTypes(), isClamped(), isDiff(), isPrecisionKept(),
  176.      keepPrecision(), resetOp(), setBias(), setClamp(), setMaxPageSize(),
  177.      setMinPageSize(), setValidOrder(), setValidType(), setWorkingType()
  178.  
  179.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllMMMMeeeemmmmCCCCaaaacccchhhheeeeIIIImmmmgggg
  180.      allocPage(), doUserPageAlloc(), enableMP(), executeRequest(),
  181.      finishRequest(), freePage(), getGlobalThrashMode(), getMpRequest(),
  182.      getPage(), getPageAllocTime(), getPageTime(), getRetainMode(),
  183.      getRetainPath(), getThrashMode(), getThrashTime(), getTotalPageTime(),
  184.      isMPenabled(), isUserPageAlloc(), prepareRequest(),
  185.      setGlobalThrashMode(), setPage(), setPageAllocTime(), setRetainMode(),
  186.      setRetainPath(), setThrashMode(),
  187.  
  188.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg
  189.      enablePagingCallback(), flush(), getCacheSize(),
  190.      isPagingCallbackEnabled(), listResident()
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  203.  
  204.  
  205.  
  206.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  207.      addInput(), allocFillData(), checkColorModel(), checkValidOrder(),
  208.      checkValidType(), clipTile(), configureRetainedCache(), copy(),
  209.      copyTile(), copyTile3D(), copyTileCfg(), fillTile(), fillTile3D(),
  210.      fillTileRGB(), freeFillData(), getColorImg(), getColorModel(),
  211.      getColormap(), getCompression(), getConfig(), getCopyConverter(),
  212.      getCsize(), getDataType(), getDimensions(), getDirectInput(),
  213.      getDisplayCacheEnable(), getFill(), getFillData(), getFillValue(),
  214.      getHeight(), getHwEnable(), getHwHint(), getHwIntHint(), getHwOp(),
  215.      getHwPassTable(), getInput(), getInputTileRequirement(),
  216.      getLockTileSet(), getMaxColormapLevels(), getMaxValue(), getMinValue(),
  217.      getNumChans(), getNumInputs(), getOrder(), getOrientation(),
  218.      getPageBorder(), getPageBorderX(), getPageBorderY(), getPageBorderZ(),
  219.      getPageCounts(), getPageDelta(), getPageDimensions(), getPageIndices(),
  220.      getPageOrigin(), getPageOriginC(), getPageOriginX(), getPageOriginY(),
  221.      getPageOriginZ(), getPageSize(), getPageSizeC(), getPageSizePix(),
  222.      getPageSizeVal(), getPageSizeX(), getPageSizeY(), getPageSizeZ(),
  223.      getPixel(), getPixel3D(), getPriority(), getScaleMax(), getScaleMin(),
  224.      getSize(), getStrides(), getSubTile(), getSubTile3D(), getTile(),
  225.      getTile3D(), getWidth(), getXsize(), getYsize(), getZsize(),
  226.      hasPageBorder(), hasPages(), hwDefine(), hwGetPass(), inherit(),
  227.      initColorModel(), initHwEnable(), initMinMax(), initPageSize(),
  228.      initScaleMinMax(), isColorImg(), isIntegral(), isMirrorOrientation(),
  229.      isPartialPage(), isSigned(), isValidPage(), isWritable(), lockPage(),
  230.      lockPageSet(), lockTile(), lockTile3D(), mapFlipTrans(), mapFromInput(),
  231.      mapFromSource(), mapOrientation(), mapSize(), mapTile(), mapToInput(),
  232.      mapToSource(), mapXY(), mapXYSign(), outOfBound(), qCopyTileCfg(),
  233.      qFillTile3D(), qFillTileRGB(), qGetSubTile3D(), qGetTile3D(),
  234.      qLockPageSet(), qSetSubTile3D(), qSetTile3D(), removeHwHint(),
  235.      removeInput(), reset(), setColorModel(), setColormap(), setCompression(),
  236.      setCsize(), setDataType(), setDisplayCacheEnable(), setFill(),
  237.      setFillValue(), setHwEnable(), setHwHint(), setHwIntHint(), setInput(),
  238.      setMaxColormapLevels(), setMaxValue(), setMinValue(), setNumChans(),
  239.      setNumInputs(), setOrder(), setOrientation(), setPageBorder(),
  240.      setPageSize(), setPageSizeC(), setPageSizeZ(), setPixel(), setPixel3D(),
  241.      setPriority(), setScaleMinMax(), setScaleType(), setSize(), setSubTile(),
  242.      setSubTile3D(), setTile(), setTile3D(), setTileRequirementFunction(),
  243.      setWritable(), setXsize(), setYsize(), setZsize(), unlockPage(),
  244.      unlockPageSet()
  245.  
  246.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  247.      addResetCallback(), alterAction(), anyAltered(), clearAllowed(),
  248.      clearSet(), clearStatus(), deleteRelated(), disableAltered(),
  249.      dumpChain(), getClassPropSet(), getDescription(), getDirectParent(),
  250.      getDisabledIndex(), getFloatProp(), getGenerationID(), getIntProp(),
  251.      getMaxIndex(), getMinIndex(), getNumChildren(), getNumParents(),
  252.      getParent(), getProp(), getProp(), getPropSet(), getPtrProp(),
  253.      getRelatedChild(), getRelatedDelete(), getRelatedType(), getStatus(),
  254.      hasResetCallbacks(), ilGetClassPropSet(), inProgress(), isAllowed(),
  255.      isAltered(), isEnabled(), isRelated(), isSet(), markSet(), mpUnlock(),
  256.      neverReset(), newRelatedType(), removeParent(), removeProp(),
  257.      removeResetCallback(), reset(), resetAltered(), resetCheck(),
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  269.  
  270.  
  271.  
  272.      setAllowed(), setAltered(), setDescription(), setDisabledIndex(),
  273.      setEnabled(), setParent(), setProp(), setPropAltered(),
  274.      setRelatedDelete(), setRelatedType(), setStatus(), stopWatching(),
  275.      unalterable(), watch(), watchNotify()
  276.  
  277. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.